/**
 *    Copyright 2009-2019 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.scripting;

import org.apache.ibatis.executor.parameter.ParameterHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.SqlSource;
import org.apache.ibatis.parsing.XNode;
import org.apache.ibatis.scripting.defaults.DefaultParameterHandler;
import org.apache.ibatis.session.Configuration;

/**
 * 脚本语言驱动器
 *
 * @see org.apache.ibatis.scripting.xmltags.XMLLanguageDriver Xml语言驱动器(默认)
 */
public interface LanguageDriver {

    /**
     * 创建一个{@link ParameterHandler}，将实际参数传递给JDBC语句
     * Creates a {@link ParameterHandler} that passes the actual parameters to the the JDBC statement.
     *
     * @param mappedStatement The mapped statement that is being executed 正在的执行的声明语句
     * @param parameterObject The input parameter object (can be null) 输入的参数对象
     * @param boundSql        The resulting SQL once the dynamic language has been executed. 生成的SQL
     * @return
     * @author Frank D. Martinez [mnesarco]
     * @see DefaultParameterHandler
     */
    ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql);

    /**
     * 创建一个{@link SqlSource}，它将保存从mapper xml文件中读取的语句。
     * 从xml文件中读取映射语句,在启动期间调用。
     * <p>
     * Creates an {@link SqlSource} that will hold the statement read from a mapper xml file.
     * It is called during startup, when the mapped statement is read from a class or an xml file.
     *
     * @param configuration The MyBatis configuration Mybatis配置
     * @param script        XNode parsed from a XML file 从XMl文件解析的XNode
     * @param parameterType input parameter type got from a mapper method or specified in the parameterType xml attribute. Can be null.输入的参数类型
     * @return
     */
    SqlSource createSqlSource(Configuration configuration, XNode script, Class<?> parameterType);

    /**
     * 创建一个{@link SqlSource}，它将保存从注解中读取的语句。
     * 从类中读取映射语句,在启动期间调用。
     * <p>
     * Creates an {@link SqlSource} that will hold the statement read from an annotation.
     * It is called during startup, when the mapped statement is read from a class or an xml file.
     *
     * @param configuration The MyBatis configuration Mybatis配置
     * @param script        The content of the annotation 注解中的内容
     * @param parameterType 参数类型 input parameter type got from a mapper method or specified in the parameterType xml attribute. Can be null.
     * @return
     */
    SqlSource createSqlSource(Configuration configuration, String script, Class<?> parameterType);

}
